YNQ  YNQ-1.6.2
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Domain Operations

Functions

NQ_BOOL ccDomainJoinA (const NQ_CHAR *domain, const NQ_CHAR *computer, const AMCredentialsA *admin, NQ_BYTE secret[16])
 
NQ_BOOL ccDomainJoin (const NQ_WCHAR *domain, const NQ_WCHAR *computer, const AMCredentials *admin, NQ_BYTE secret[16])
 
NQ_BOOL ccDomainJoinPersistent (const NQ_WCHAR *domain, const NQ_WCHAR *computer, const AMCredentials *admin, const NQ_WCHAR *dns)
 
NQ_BOOL ccDomainUpdateSecretA (const NQ_CHAR *domain, const NQ_CHAR *computer, const AMCredentialsA *admin, NQ_BYTE secret[16])
 
NQ_BOOL ccDomainUpdateSecret (const NQ_WCHAR *domain, const NQ_WCHAR *computer, const AMCredentials *admin, NQ_BYTE secret[16])
 
NQ_BOOL ccDomainLeaveA (const NQ_CHAR *domain, const NQ_CHAR *computer, const AMCredentialsA *admin)
 
NQ_BOOL ccDomainLeave (const NQ_WCHAR *domain, const NQ_WCHAR *computer, const AMCredentials *admin)
 
NQ_BOOL ccDomainLogonA (const NQ_CHAR *domain, const NQ_CHAR *computer, const AMCredentialsA *admin, NQ_BYTE secret[16])
 
NQ_BOOL ccDomainLogon (const NQ_WCHAR *domain, const NQ_WCHAR *computer, const AMCredentials *admin, NQ_BYTE secret[16])
 

Detailed Description

Function Documentation

NQ_BOOL ccDomainJoinA ( const NQ_CHAR domain,
const NQ_CHAR computer,
const AMCredentialsA admin,
NQ_BYTE  secret[16] 
)

This function joins target computer to the domain.

After successfully joining domain, this function returns a computer password obtained from domain controller to be used for further logging into domain. This operation requires domain administrative credentials.

Parameters
domainName of the domain to join. This may be a fully qualified name.
computerName of the computer (host) that joins.
adminAdministrative credentials for its domain.
secretBuffer for computer password. This buffer should accommodate at least 16 bytes .
Returns
This function returns TRUE if computer succeeded to join the domain or FALSE otherwise. The application can inspect the error code for the failure reason.
See Also
ccDomainLogon() ccDomainLeave() AMCredentials structure in amapi.h File Operations.
Note
This is an ASCII version of ccDomainJoin()
NQ_BOOL ccDomainJoin ( const NQ_WCHAR domain,
const NQ_WCHAR computer,
const AMCredentials admin,
NQ_BYTE  secret[16] 
)

This function joins target computer to the domain.

After successfully joining domain, this function returns a computer password obtained from domain controller to be used for further logging into domain. This operation requires domain administrative credentials.

Parameters
domainName of the domain to join. This may be a fully qualified name.
computerName of the computer (host) that joins.
adminAdministrative credentials for its domain.
secretBuffer for computer password. This buffer should accommodate at least 16 bytes .
Returns
This function returns TRUE if computer succeeded to join the domain or FALSE otherwise. The application can inspect the error code for the failure reason.
See Also
ccDomainLogon() ccDomainLeave() AMCredentials structure in amapi.h File Operations.
NQ_BOOL ccDomainJoinPersistent ( const NQ_WCHAR domain,
const NQ_WCHAR computer,
const AMCredentials admin,
const NQ_WCHAR dns 
)

This function joins target computer to the domain.

After successfully joining domain, this function returns a computer password obtained from domain controller to be used for further logging into domain. This operation requires domain administrative credentials.

Parameters
domainName of the domain to join. This may be a fully qualified name.
computerName of the computer (host) that joins.
adminAdministrative credentials for its domain.
dnsA semicolon delimited list of DNS servers, can be NULL.
Returns
This function returns TRUE if computer succeeded to join the domain or FALSE otherwise. The application can inspect the error code for the failure reason.
See Also
ccDomainLogon() ccDomainLeave() AMCredentials structure in amapi.h File Operations.
NQ_BOOL ccDomainUpdateSecretA ( const NQ_CHAR domain,
const NQ_CHAR computer,
const AMCredentialsA admin,
NQ_BYTE  secret[16] 
)

This function joins target computer to the domain or updates the password (secret) for previously joined computer.

On success this function returns a computer password obtained from domain controller to be used for further logging into domain. This operation requires domain administrative credentials.

Parameters
domainName of the domain to join. This may be a fully qualified name.
computerName of the computer (host) that joins.
adminAdministrative credentials for its domain.
secretBuffer for computer password. This buffer should accommodate at least 16 bytes.
Returns
This function returns TRUE if computer succeeded to join the domain or when computer account password was updated (in case when account already existed on domain), FALSE otherwise. The application can inspect the error code for the failure reason.
See Also
ccDomainJoin() ccDomainLogon() ccDomainLeave() AMCredentials structure in amapi.h File Operations.
Note
This is an ASCII version of ccDomainUpdateSecret()
NQ_BOOL ccDomainUpdateSecret ( const NQ_WCHAR domain,
const NQ_WCHAR computer,
const AMCredentials admin,
NQ_BYTE  secret[16] 
)

This function joins target computer to the domain or updates the password (secret) for previously joined computer.

On success this function returns a computer password obtained from domain controller to be used for further logging into domain. This operation requires domain administrative credentials.

Parameters
domainName of the domain to join. This may be a fully qualified name.
computerName of the computer (host) that joins.
adminAdministrative credentials for its domain.
secretBuffer for computer password. This buffer should accommodate at least 16 bytes.
Returns
This function returns TRUE if computer succeeded to join the domain or when computer account password was updated (in case when account already existed on domain), FALSE otherwise. The application can inspect the error code for the failure reason.
See Also
ccDomainJoin() ccDomainLogon() ccDomainLeave() AMCredentials structure in amapi.h File Operations.
NQ_BOOL ccDomainLeaveA ( const NQ_CHAR domain,
const NQ_CHAR computer,
const AMCredentialsA admin 
)

This function cancels domain membership of the target computer.

Parameters
domainName of the domain to leave.
computerName of the computer (host) that leaves.
adminAdministrative credentials for its domain.
Returns
This function returns TRUE if computer successfully leaves the domain or FALSE otherwise. The application can inspect the error code for the failure reason.
See Also
ccDomainJoin() AMCredentials structure in amapi.h File Operations.
Note
This is an ASCII version of ccDomainLeave()
NQ_BOOL ccDomainLeave ( const NQ_WCHAR domain,
const NQ_WCHAR computer,
const AMCredentials admin 
)

This function cancels domain membership of the target computer.

Parameters
domainName of the domain to leave.
computerName of the computer (host) that leaves.
adminAdministrative credentials for its domain.
Returns
This function returns TRUE if computer successfully leaves the domain or FALSE otherwise. The application can inspect the error code for the failure reason.
See Also
ccDomainJoin() AMCredentials structure in amapi.h File Operations.
NQ_BOOL ccDomainLogonA ( const NQ_CHAR domain,
const NQ_CHAR computer,
const AMCredentialsA admin,
NQ_BYTE  secret[16] 
)

This function performs domain logon operation supplying a password obtained from domain controller by calling ccDomainJoin().

Parameters
domainName of the domain to log on.
computerComputer (host) name.
adminUser credentials.
secretPassword as obtained when joining domain.
Returns
This function returns TRUE if the computer has successfully logged with the domain controller or FALSE otherwise. The application can inspect the error code for the failure reason.
See Also
AMCredentials structure in amapi.h File Operations.
Note
This is an ASCII version of ccDomainLogon()
NQ_BOOL ccDomainLogon ( const NQ_WCHAR domain,
const NQ_WCHAR computer,
const AMCredentials admin,
NQ_BYTE  secret[16] 
)

This function performs domain logon operation supplying a password obtained from domain controller by calling ccDomainJoin().

Parameters
domainName of the domain to log on.
computerComputer (host) name.
adminUser credentials.
secretPassword as obtained when joining domain.
Returns
This function returns TRUE if the computer has successfully logged with the domain controller or FALSE otherwise. The application can inspect the error code for the failure reason.
See Also
AMCredentials structure in amapi.h File Operations.